home *** CD-ROM | disk | FTP | other *** search
/ BBS Toolkit / BBS Toolkit.iso / doors_2 / search32.zip / SEARCH.DOC < prev    next >
Text File  |  1992-09-22  |  23KB  |  494 lines
  1.  
  2.  
  3.                               WORD  SEARCH
  4.  
  5.                                   v3.2
  6.  
  7.                                    by
  8.  
  9.                               Al Lawrence
  10.  
  11.                             Sunrise-80  BBS
  12.                             (404) 256-9525
  13.  
  14.  
  15.  
  16.  
  17.                                 OVERVIEW
  18.                                 ________
  19.  
  20.  
  21.    Word Search is a computerized adaptation of the type of puzzles normally
  22.    found in puzzle books, newspapers and magazines. Given a list of words, 
  23.    you must find them in the letter grid. They are hidden horizontally, 
  24.    vertically, diagonally, in both normal and reverse order spelling.
  25.  
  26.  
  27.    NOTE: Most errors will be logged to a file called DFRAME.ERR, which is
  28.          created in the directory you run the door from.
  29.  
  30.  
  31.  
  32.                               INSTALLATION
  33.                               ____________
  34.  
  35.  
  36.    Installation is fairly easy and straight-forward. The following steps and
  37.    examples should have you up and running in a very short period of time.
  38.    It is assumed that you are familiar with setting up DOORS on your system.
  39.    To this end, only examples of the configuration file and Door batch file
  40.    are described.
  41.  
  42.       1) Create a directory to hold all SEARCH files
  43.  
  44.       2) Unzip SEARCHxx.ZIP into the the above directory
  45.  
  46.          NOTE: BRUN45.EXE is not included but is required !!!
  47.  
  48.       3) Create a configuration file, with a name of your choice, or
  49.          modify the supplied SEARCH.CFG file. A description follows:
  50.  
  51.             **                       Location of system file (See Below)
  52.             SUNRISE-80 BBS           Your BBS Name
  53.             Al                       Sysop's First nameAP
  54.  
  55.             Lawrence                 Sysop's Last Name
  56.  
  57.             00000000                 Registration Number
  58.  
  59. |-----------------------------------------------------------------------------|
  60. | READ!     1                        CommPort  \ These 2 lines are required   |
  61. | READ!     1                        Node #    / ONLY for GTUSER.BBS          |
  62. |-----------------------------------------------------------------------------|
  63.  
  64.     !   #   2                        Maximum # of Games per day
  65.                                      (Sysop gets 99 in Registered version ONLY!)
  66.  
  67.         #   0                        Max # of days a caller can make up, during
  68.                                      calls in one day. 0=Disable Make-up Option
  69.                                      Maximum value = 27, Minimum value = 1
  70.  
  71.         #   NONE                     Drive:\Path\Filename to contain the
  72.                                      Top Score Bulletin or enter NONE
  73.                                      for NO Bulletin creation.
  74.  
  75.         #   NONE                     Drive:\Path\Filename to contain the
  76.                                      Top Score Bulletin (Color) or enter NONE
  77.                                      for NO Bulletin creation.
  78.  
  79.         #   NONE                     Drive:\Path\Filename to contain the
  80.                                      Hall of Fame Bulletin or enter NONE
  81.                                      for NO Bulletin creation.
  82.  
  83.         #   NONE                     Drive:\Path\Filename to contain the
  84.                                      Hall of Fame Bulletin (Color) or enter NONE
  85.                                      for NO Bulletin creation.
  86.  
  87.             2                        1 = DO NOT Display ADOPT-A-DOOR Message
  88.                                      2 = Display ADOPT-A-DOOR message
  89.  
  90.         #   2                        Keyboard timeout value in Minutes
  91.  
  92.  
  93.         #   2                        Max. time to play each word (1-4 Minutes)
  94.  
  95.         #   5                        Number of words to hide in the grid(1-9)
  96.  
  97.     !   #   0                        Time Allowed in Door
  98.                                      (Sysop = Time Remaining - REG. VERSION)
  99.  
  100.         #   N                        Automatic game reset at end of month:
  101.                                        Y = Yes enable autoreset
  102.                                        N = Keep accumulating scores
  103.  
  104.     !   #   000=00/00                 Security Level/Games Allowed Per Day
  105.     !   #   000=00/00                 Security Level/Games Allowed Per Day
  106.     !   #   000=00/00                 Security Level/Games Allowed Per Day
  107.     !   #   000=00/00                 Security Level/Games Allowed Per Day
  108.     !   #   000=00/00                 Security Level/Games Allowed Per Day
  109.     !   #   000=00/00                 Security Level/Games Allowed Per Day
  110.     !   #   000=00/00                 Security Level/Games Allowed Per Day
  111.     !   #   000=00/00                 Security Level/Games Allowed Per Day
  112.     !   #   000=00/00                 Security Level/Games Allowed Per Day
  113.     !   #   000=00/00                 Security Level/Games Allowed Per Day
  114.  
  115.     @   #   XXXX/YYYY                 Blackout Range  From/To
  116.     @   #   XXXX/YYYY                 Blackout Range  From/To
  117.     @   #   XXXX/YYYY                 Blackout Range  From/To
  118.     @   #   XXXX/YYYY                 Blackout Range  From/To
  119.     @   #   XXXX/YYYY                 Blackout Range  From/To
  120.           ** = Replace with ONE of the following:
  121.  
  122. C:\PCB\PCBOARD.SYS              <- For PCBoard systems using PCBOARD.SYS only
  123. C:\BBS\CALLINFO.BBS             <- For Wildcat! systems (prior to v3.0)
  124. C:\BBS\USERINFO.DAT             <- For Wildcat! systems using v3.x
  125.                                    (Note:DOOR.SYS must be in SAME directory)
  126. C:\BBS\DOOR.SYS                 <- For ANY systems that support DOOR.SYS
  127. C:\BBS\DORINFOx.DEF             <- For ANY systems that support DORINFOx.DEF
  128. C:\BBS\SFDOORS.DAT              <- For Spitfire systems.
  129. c:\bbs\TRIBBS.SYS               <- For TriBBS systems.
  130. C:\BBS\CHAIN.TXT                <- For WWIV systems 
  131. C:\BBS\GTUSER.BBS               <- For GT Power 
  132.                                    * if using this option you must put the
  133.                                      ComPort # on line 5 and the Node # on
  134.                                      line 6 of the configuration file
  135.  
  136.  
  137.            # = Requires registration to change to a different value.
  138.            ! = See "Plays Per DAY/DOOR Time" Below
  139.            @ = See "Blackout Periods" Below
  140.  
  141.  
  142.                NOTE: There are NO Blank Lines in the Config File!!
  143.  
  144.  
  145.       4) Create a batch file or modify the PAIR3 file supplied. A
  146.          description of this file follows:
  147.  
  148.             ECHO off
  149.             cd\PCB\DOORS\SEARCH       Location of Search files
  150.             SEARCH SEARCH.CFG         EXE filename and CNF filename (Name
  151.                                       used in creating file in #3 above)
  152.             CD\PCB
  153.             BOARD
  154.  
  155.  
  156.        5) When running in more than one node, be sure to supply a
  157.           different configuration name for each node (your choice of name).
  158.  
  159.   
  160.          
  161.                MAKE-UP DAYS (Registered version only)
  162.                --------------------------------------
  163.  
  164. The Make-Up-Day feature allows the caller to make up any plays he/she missed 
  165. during the current month and prior to the current call. You control whether 
  166. to allow this option, as well as the number of days the caller can make up, on
  167. any prticular days worth of calls. Entering a 0 (zero) for this option, in the
  168. configuration file, turns the option OFF, any other value (up to a max of 27)
  169. turns the option ON and dictates the number of days the caller can make up.
  170.  
  171.  
  172. NOTE:      The number of games per day is calculated as follows...
  173.  
  174.            Games Allowed per day x Number of makeup days.
  175.  
  176. Example:   Games Allowed per day = 2
  177.            Max # of makeup days  = 4
  178.  
  179. If a caller logs in on 5/8/92 and this is their first call of the month, they
  180. would have a potential of 16 games to makeup and bring them current 
  181. (8 days (5/8/92) * 2 (games per day)). However, since the maximum # of Makeup
  182. Days is set at 4, the maximum # of games the caller can play on 5/8/92, is 8 
  183. (games allowed * max # of makeup days).
  184.  
  185.  
  186.  
  187.              HALL OF FAME BULLETINS (Registered version only)
  188.              ------------------------------------------------
  189.  
  190. The program will automatically reset the game when the first caller of the
  191. month plays the game. The score file will be cleared and a set of Hall of Fame
  192. bulletin files will be created. The files will be called SUNHOF.ASC and 
  193. SUNHOF.ANS (ASCII and ANSI versions). The files will be placed in the same 
  194. directory as the BETSY.EXE file. You are responsible for COPYING the files to 
  195. your bulletin area and renaming to a filename of your choice.
  196.  
  197. WARNING: The HOF files are cumulative files. That means they are read in each 
  198.          month and updated. DO NOT DELETE EITHER FILE!!!! or you will lose
  199.          the record of prior months winners!!!!
  200.   
  201.  
  202.  
  203.                           BLACKOUT PERIODS
  204.                           ________________
  205.  
  206.       Use the Blackout ranges option to define up to 5 time periods during
  207.       which you DO NOT want the Door to be played. If a caller tries to access 
  208.       the Door during the Blackout period, they will be shown a message that
  209.       contains ALL the Blackout periods you have defined, and to try the Door
  210.       at a later time.
  211.  
  212.       Each of the 5 Blackout ranges takes the form of XXXX/YYYY, where
  213.       XXXX=beginning time and YYYY=the ending time. For example, 0930/1230
  214.       means to NOT allow the Door to be played between 9:30am and 12:30pm.
  215.  
  216.       IMPORTANT: - All times must be 4 digits & must follow the XXXX/YYYY format
  217.                  - DO NOT change the XXXX/YYYY entry UNLESS you want to assign
  218.                    a Blackout range.
  219.                  - You MUST use the MILITARY time format. Example: 2030=8:30pm
  220.                    0900=9am, 0030=12:30am, 1700=5pm, etc.
  221.  
  222.                    
  223.                           PLAYS Per DAY/DOOR Time
  224.                           _______________________
  225.  
  226.       Plays Per Day and Door Time can be controlled several ways:
  227.  
  228.       (1) You can use the Games Per Day, singular option, in the config
  229.           file above. This option, will affect ALL callers whose Security
  230.           Level is NOT defined in any of the 10 optional Security Level/
  231.           Plays Per Day entries in the config file.
  232.  
  233.       (2) You can use the Door Time, singular option, in the config file
  234.           above. This option, will affect ALL callers whose Security
  235.           Level is NOT defined in any of the 10 optional Security Level/
  236.           Plays Per Day/Door Time entries in the config file.
  237.  
  238.       (3) You can restrict the number of games a specific Security Level
  239.           will be allowed to play per day or REWARD specific Levels with 
  240.           more Plays Per Day. 
  241.  
  242.           Likewise, you can restrict the Play time for a specific Security
  243.           Level or REWARD specific Levels with more Door Time.
  244.  
  245.           These options are handled by the use of the 10 config 
  246.           entries (000=00/00). 
  247.           
  248.           The format of each entry is as follows:
  249.  
  250.           XXX=YY/ZZ  where XXX is the Security Level (must be 3 digits)
  251.                      where =  is a constant and MUST be included
  252.                      where YY is the # of games per day (must be 2 digits)
  253.                      where / is a constant and MUST be included
  254.                      where ZZ is num. minutes per Door entry (must be 2 digits)
  255.           
  256.           If the callers Security Level is NOT defined, his/her Plays Per
  257.           Day and Door Time will be controlled by the values in items
  258.           (1) and (2), above, respectively..
  259.  
  260.           You may define up to 10 Security Levels. All unused entries must
  261.           be defined as   000=00/00
  262.         --------------------------------------------------------------------
  263.           Example: Suppose you had 3 Security Levels defined on your BBS as
  264.           (20=Subscriber, 30=Visiting Sysop, 40=CoSysop, 90=Friend) and you 
  265.           wanted to set Plays Per Day as :     Subscriber=5
  266.                                            Visiting Sysop=2
  267.                                                   CoSysop=3
  268.                                                    Friend=10 
  269.           
  270.           and Door Time as follows:     Subscriber=30 minutes
  271.                                     Visiting Sysop=20 minutes
  272.                                            CoSysop=10 minutes 
  273.                                             Friend=remaining call time
  274.                                
  275.  
  276.           You would set the Individual "Games per Day" config entry to 1 and 
  277.           the individual "Door Time" to 5 minutes (these would be the 
  278.           default number of games and default Time for all Security Levels
  279.           other than 20,30 or 40... make them any number you want). Next you
  280.           would replace 4 of the Security Level entries as :  020=05/30                                               
  281.                                                               030=02/20
  282.                                                               040=03/10
  283.                                                               090=10/0
  284.  
  285.  
  286.  
  287.     
  288.  
  289.                                WORD FILE
  290.                                _________
  291.  
  292.      In the unregistered version of Word Search there is an interenal word
  293.      list, containing 15 words. When you register the door, the program will
  294.      access the SEARCH.QUE file, which will initially contain 200 words. You
  295.      are free to create your own list or modify the supplied list (using any 
  296.      word processor or editor). The length of each word must not exceed 9 
  297.      characters and the name of the file must be SEARCH.QUE.
  298.  
  299.      The number of puzzles contained in the file is important. There must be 
  300.      enough puzzles in the file equal to or greater than the following formula:
  301.  
  302.               MAXIMUM GAMES per DAY  x  NUMBER WORDS to HIDE + 10
  303.  
  304.      For example: if your configuration file was setup to allow the caller to
  305.      play 5 games per day and to hide 9 words, then the minimum number of
  306.      words you would have to have in the SEARCH.QUE file would be 55.
  307.  
  308.      NOTE: This also applies to the Sysop games per day. In order to play the
  309.      maximum 99 games per day, with 9 hidden words per game, you would need 
  310.      901 words in the SEARCH.QUE file (which is also the limit for the file).
  311.          
  312.  
  313.         
  314.                         NON-STANDARD COM SUPPORT
  315.                         ________________________
  316.  
  317.       Support for COM 1-4 on the standard IRQ's - COM1/COM3 = IRQ4 and
  318.       COM2/COM4 = IRQ3. If you wish to use a non-standard IRQ, add the IRQ
  319.       number after the configuration filename. Let's assume your Door is
  320.       called FOOBAR and you want to use COM1 and IRQ5. The command line
  321.       passed to your Door would be:
  322.  
  323.                             FOOBAR FOOBAR.CFG /5
  324.  
  325.       The /5 tells FOOBAR to use IRQ5 rather than the standard IRQ4 that is
  326.       normally used with COM1. No /x parameter is needed for the standard
  327.       IRQ's.
  328.  
  329.       As an alternative, you may use an environmental variable on the command
  330.       line. To use the variable (following the example above), place a 
  331.       SET IRQ=5 in the batch file used to bring up your BBS (you would need a 
  332.       different IRQ number for each node). The command line would now look 
  333.       like this: 
  334.  
  335.                           FOOBAR FOOBAR.CFG /%IRQ%
  336.       
  337.       This, in combination with the use of the environmental variables 
  338.       described in the MULTI-NODE SETUP section will allow you to use one 
  339.       batch file and one config file to run this door on all nodes.
  340.  
  341.  
  342.  
  343.  
  344.                            MULTI-NODE SETUP
  345.                            ________________
  346.  
  347.       All Sunrise Doors are Multi-Node capable. Each node must have the 
  348.       ability to access a configuration file which will have its own system 
  349.       file (DORINFOx.DEF, PCBOARD.SYS, DOOR.SYS, etc) defined on the first 
  350.       line. There are 2 ways to accomplish this:
  351.  
  352.       (1) Create a separate configuration file for each node. The only 
  353.           difference between each file would be the location of the system 
  354.           file for that particular node. For example, on my system there are 2
  355.           nodes and the first line of the config files would look like this:
  356.  
  357.                         NODE1:  H:\PCB1\DOOR.SYS
  358.                         NODE2:  H:\PCB2\DOOR.SYS
  359.  
  360.           Thus, if you have a 4 node BBS, you will need 4 configuration files.
  361.  
  362.       (2) Use ONE configuration file for ALL nodes. This Door will recognize 
  363.           the following PCBoard environmental variables:
  364.  
  365.                  PCBDIR    (Directory containing the System file)
  366.                  PCBDRIVE  (Drive containing the System file)
  367.  
  368.           Thus, the first line of the SINGLE configuration file, for this Door
  369.           would look like this:
  370.  
  371.                         %PCBDRIVE%%PCBDIR%\DOOR.SYS
  372.  
  373.       NOTE: This option, as described, assumes that you are running PCBoard 
  374.             14.5a software. The environmental variables are automatically 
  375.             created by the software for each node.
  376.  
  377.             HOWEVER, if you are running other BBS software you should be able
  378.             to set the variables EXACTLY as described below, for EACH node 
  379.             (more than likely in each batch file you use to bring up EACH node):
  380.  
  381.                             PCBDRIVE=C:
  382.                             ^^^^^^^^^
  383.                             PCBDIR=\NODE2
  384.                             ^^^^^^^^
  385.             
  386.             Info with a carat (^) under it, MUST be typed as is. The rest 
  387.             depends on your naming conventions. 
  388.  
  389.             This, in combination with the use of the optional environmental
  390.             variable described in the NON-STANDARD COM SUPPORT section, will
  391.             allow you to use one batch file and one config file to run this 
  392.             door on all nodes.
  393.  
  394.  
  395.  
  396.  
  397.                                ADOPT-A-DOOR
  398.                                ____________
  399.  
  400.     Having been a Sysop for a number of years, I have had my share of problems
  401.     and frustrations getting financial support for my board's upkeep. A fellow
  402.     Sysop left a message on my board, not long ago, about a concept that was
  403.     being used by several boards around the country.
  404.  
  405.     The concept, ADOPT-A-DOOR, allows a caller to register (ADOPT) a door. It
  406.     would be the same as sending in a donation, only this way it is earmarked
  407.     for registering a particular door. In a way, the user feels he/she is
  408.     "getting something in return". As a Door author I have decided to build
  409.     this concept into each of my Door programs. The concept replaces the
  410.     usual message "tell the Sysop to register this Door" we find in most
  411.     doors.
  412.  
  413.     If the Door is unregisterd then a message appears on the opening screen
  414.     to that effect. After finishing or suspending a game, a message screen
  415.     is displayed about the ADOPT-A-DOOR concept. The message also tells the
  416.     caller to contact the Sysop to find out if there is any further details
  417.     to the ADOPT-A-DOOR concept. Some Sysops give extra D/L time, online
  418.     time, etc to callers that ADOPT-A-DOOR.
  419.  
  420.     If the Door has been registered, either by the Sysop or other callers,
  421.     the names of those contributors will be displayed in the closing screen.
  422.  
  423.     NOTE: If you want to display the names of the callers that contributed
  424.           to registering the Door, you must create an ASCII file called
  425.           ADOPT.SYS. You create it with an Editor or Word Processor. Enter
  426.           the name(s) of the contributors (one on each line, maximum of 5
  427.           entries, each a maximum of 30 characters long). This file must be
  428.           saved, in ASCII format, and placed in the Door directory.
  429.  
  430.  
  431.  
  432.                               LEGALITIES
  433.                               __________
  434.  
  435.  
  436.       THIS SOFTWARE AND ACCOMPANYING MATERIALS ARE DISTRIBUTED "AS IS"
  437.       WITHOUT WARRANTY, EXPRESS, IMPLIED OR STATUTORY, INCLUDING BUT NOT
  438.       LIMITED TO ANY IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
  439.       FOR A PARTICULAR PURPOSE. IN NO EVENT SHALL ANYONE INVOLVED WITH
  440.       THE CREATION AND PRODUCTION OF THIS PRODUCT BE LIABLE FOR INDIRECT,
  441.       SPECIAL, OR CONSEQUENTIAL DAMAGES, ARISING OUT OF ANY USE THEREOF
  442.       OR BREACH OF ANY WARRANTY.
  443.  
  444.  
  445.  
  446.  
  447.  
  448.                              DISTRIBUTION
  449.                              ____________
  450.  
  451.    You may make this file available for downloading from your BBS or you may
  452.    upload it to any BBS of your choice, provided that you do not make any
  453.    changes to the contents of the archive (ZIP file). The archive and its
  454.    individual contents may not be used by any service that charges any money
  455.    whatsoever, without the written permission of the author.
  456.  
  457.  
  458.  
  459.  
  460.  
  461.                              REGISTRATION
  462.                              ____________
  463.  
  464.    Registration and the subsequent insertion of the registration number into
  465.    your configuation file, allows for the display of your BBS name on the
  466.    opening and closing screen as well as the reduction of a delay built into
  467.    the opening screen display along with the ability to change certain values
  468.    in the configuration file.
  469.  
  470.    To register your copy of SEARCH, please fill out the registration form
  471.    (REGISTER.FRM) and mail it along with the registration fee to
  472.    the name and address on the form.
  473.  
  474.    Be sure to use the proper upper/lower case when filling in your name and
  475.    BBS name, as they MUST match the way you entered them in the configuration
  476.    file.             ^^^^
  477.  
  478.    Based upon information supplied on the registration form, I will pre-
  479.    register you on my BBS. You will then be able to call SUNRISE-80 and pick
  480.    up your registration number.
  481.  
  482.  
  483.  
  484.                                  MISC
  485.                                  ____
  486.  
  487.    The latest version of WORD SEARCH and other fine SUNRISE DOOR programs
  488.    are always available for download from SUNRISE-80 BBS.
  489.  
  490.    Remember, should you have any problems, questions or suggestions, be sure
  491.    to drop me a message on Sunrise-80 or you can reach me through the
  492.    RIME (BBS Doors, Sysops, PCBHints), SmartNet, FIDOnet 1:133/410
  493.  
  494.